Skip to main content

SetColumnBackgroundColor

Sets the background color to all cells in the column containing the current cell.

Syntax

expression.SetColumnBackgroundColor(r, g, b, bNone);

expression - A variable that represents a ApiTableCell class.

Parameters

NameRequired/OptionalData typeDefaultDescription
rRequiredbyteRed color component value.
gRequiredbyteGreen color component value.
bRequiredbyteBlue color component value.
bNoneRequiredbooleanDefines that background color will not be set.

Returns

boolean

Example

This example sets the background color to all cells in the column containing the cell.

let doc = Api.GetDocument();
let tableStyle = doc.CreateStyle("CustomTableStyle", "table");
tableStyle.SetBasedOn(doc.GetStyle("Bordered"));
let table = Api.CreateTable(4, 2);
table.SetWidth("percent", 100);
table.SetStyle(tableStyle);
let cell = table.GetRow(0).GetCell(0);
cell.SetColumnBackgroundColor(255, 111, 61, false);
doc.Push(table);